XMPP (Jabber) Chat Relay

XMPP (Jabber) Chat Relay

This is an event handling function that monitors player chat and sends it to XMPP (Jabber) room of your choice. Chat from this room is also returned to the server and show in game chat.

Furthermore, any number of administrative XMPP (Jabber) users can be configured who will be allowed to perform commands directly from the XMPP (Jabber) chat. These commands will be executed as if typed into a console on the server itself, therefore care must be taken when allowing users this functionality.

---

Configuration

There are 8 config options added to accommodate the XMPP (Jabber) Chat Relay system:

• xmppUser - name of the user under which we'll log in to the XMPP (Jabber) service itself. Default: none
• xmppHost - the XMPP (Jabber) server, e.g. jabber.com (so when your username is john@jabber.com, user = john, host = jabber.com). Default: localhost
• xmppPassword - password to use to log the user into the server. Default: none
• xmppRoom - name of the room where all chat will happen. This is REQUIRED. You may need to find a service which provides Jabber rooms. I use conf.netlab.cz, therefore my room name is "myroom@conf.netlab.cz" - myroom being the room name, conf.netlab.cz the hostname. Default: none
• xmppRoom.password - if the room requires a password to join it, set it up here. Default: none
• xmppBotNick - this is the nickname for the plugin. All chat will originate from this nickname. You will, however see who did each chat message originate from.. Default: CommandsEX
• xmppCommandPrefix - when a person from the Jabber room starts line with this character, it will be passed through to the Bukkit server and executed as if it was an ordinary command from the CONSOLE! Therefore be sure to only add players to xmppAdmins you really trust! Default: #
• xmppAdmins - list of XMPP (Jabber) users who have the right to send commands to Bukkit server. Example = xmppAdmins: [zathrus_writer, johny_cash]. Default: [], e.g. no users
• privateMsgCommands - this lets CommandsEx know what commands are used for private messaging, so that they can be forwarded to the XMPP chat room.

---

How to remove this feature

Should there be a need to manually remove this feature from the JAR file, the following file must be removed: com/github/zathrus_writer/commandsex/handlers/Handler_xmpp.class

This feature also utilizes external library Smack. When removing XMPP Chat Relay functionality, you would also want to remove files called smack.jar and smackx.jar from your CommandsEX folder under your plugins directory.

If you, however would like to return this functionality to place later on, do not forget to copy these 2 files back or you won't be able to use the chat bridge.